ValidatedIdentifierMap
A Validated Map with Identifier Keys
Author
fzzyhmstrs
Since
0.2.0
Parameters
any non-null type with a valid Entry for handling
the default map
ValidatedIdentifier key handler
the value handler, an Entry
See also
using the builder is recommended
Samples
import me.fzzyhmstrs.fzzy_config.util.EnumTranslatable
import me.fzzyhmstrs.fzzy_config.validation.Shorthand.validated
import me.fzzyhmstrs.fzzy_config.validation.collection.*
import me.fzzyhmstrs.fzzy_config.validation.minecraft.ValidatedIdentifier
import me.fzzyhmstrs.fzzy_config.validation.misc.ValidatedBoolean
import me.fzzyhmstrs.fzzy_config.validation.misc.ValidatedString
import me.fzzyhmstrs.fzzy_config.validation.number.ValidatedInt
import net.minecraft.registry.Registries
import net.minecraft.util.Identifier
fun main() {
//sampleStart
//Example ValidatedIdentifierMap with identifiers restricted to all registered enchantments
val validatedIdentifierMap = ValidatedIdentifierMap(mapOf(Identifier("sharpness") to true),
ValidatedIdentifier.ofRegistry(Registries.ENCHANTMENT), ValidatedBoolean())
//fields and sections have lang keys based on their "location" in the Config class graph.
//Lange key composition is as follows
//1. the namespace of the config id: (my_mod)
//2. the path of the config id: (my_mod.my_config)
//3. any parent ConfigSection field names as declared in-code: (my_mod.my_config.subSection)
//4. the setting field name as declared in-code: (my_mod.my_config.subSection.fieldName)
val fieldLang = """
{
"_comment1": "the lang for an example 'fieldName' setting in a config inside section 'subSection'",
"my_mod.my_config.subSection.fieldName": "Very Important Setting",
"my_mod.my_config.subSection.fieldName.desc": "This very important setting is used in this very important way."
}
"""
//sampleEnd
}Constructors
Types
Properties
Functions
updates the wrapped value. NOTE: this method will push updates to an UpdateManager, if any. For in-game updating consider validateAndSet
Attaches a listener to this field. This listener will be called any time the field is written to ("set"). accept, validateAndSet, setAndUpdate and so on will all call the listener.
Creates a deep copy of the stored value and returns it
The translated Text description from the descriptionKey. Falls back to an empty string so no tooltip is rendered.
translation key of this Translatable's description. the "description" in-game, the descriptions Enchantment Descriptions adds to enchantment tooltips are a good example.
Provides this validations default value
Whether this Translatable has a valid description
Whether this Translatable has a valid translation
creates a deep copy of this ValidatedIdentifierMap return ValidatedIdentifierMap wrapping a deep copy of the currently stored map, as well as passing keyHandler and valueHandler
Maps this validation to a new convertible type. The default value will be applied from this delegates current storedValue
Maps this validation to a new convertible type.
Convert this field to a ValidatedCondition using the provided validation as a supplier. The provided condition (and any others you append) must pass for the stored value to be provided, otherwise the fallback will be supplied.
Convert this field to a ValidatedCondition. The provided condition (and any others you append) must pass for the stored value to be provided, otherwise the fallback will be supplied.
Convert this field to a ValidatedCondition using the provided scope with a default boolean provider. The provided condition (and any others you append) must pass for the stored value to be provided, otherwise the fallback will be supplied. The provided scope must point to a valid boolean config scope otherwise the initial condition will never pass.
wraps the provided values into a ValidatedList with this field as validation
wraps the provided collection into a ValidatedList with this field as validation
wraps the provided values into a ValidatedSet with this field as validation
wraps the provided collection into a ValidatedSet with this field as validation
The translated Text name from the translationKey. Falls back to the implementing classes Simple Name (non-translated)
translation key of this Translatable. the "name" in-game
A setter method for the storedValue that first validates the value being set and then stores the post-validation result.
A setter method for the storedValue that first validates the value being set and then stores the post-validation result.